home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / UTILITIES / FILTERS.SPK / !Filters / !Help < prev    next >
Text File  |  1996-07-23  |  16KB  |  350 lines
  1. -------------------------------------------------------------------------------
  2.  
  3.         TaskFilters
  4.  
  5.                                                         by Andrew Kemp
  6.  
  7.                                                         © KCE Software, 1996
  8.  
  9. -------------------------------------------------------------------------------
  10.  
  11.  
  12. Purpose
  13. -------
  14.         TaskFilters provides a number of 'patches' to the Desktop:
  15.  
  16.                 1. SetCSD
  17.                 2. Confirm
  18.                 3. IconSprite
  19.                 4. FilerPin
  20.                 5. DontClaim
  21.                 6. PinFilter
  22.                 7. Basket
  23.                 8. Iconise
  24.  
  25.         The effects of these are as follows:
  26.  
  27.         1. SetCSD
  28.         ---------
  29.         SetCSD provides an easy way of setting the currently selected directory
  30.         (CSD) from the desktop. To do this, just drag the switcher icon (the
  31.         Acorn on the right hand side of the iconbar) using ADJUST, and drop it
  32.         into the relevant directory display.
  33.  
  34.         SetCSD is on by default (see 'Configuration').
  35.  
  36.         2. Confirm
  37.         ----------
  38.         Confirm is very simple in use. Its sole function is to force the filer
  39.         to ask confirmation of delete operations, but only those. So if you
  40.         turn off 'Confirm' in the Filer options menu, you no longer need be
  41.         bothered by giving confirmation for things like copy operations - only
  42.         when deleting files.
  43.  
  44.         N.B.    Confirm _only_ acts on operations performed under the filer
  45.                 action window, not on single tasking file processes. Use
  46.                 !Configure to turn on interactive file copying, and make sure
  47.                 you have enough memory for the filer action window to start
  48.                 up...
  49.  
  50.         Confirm is on by default (see 'Configuration').
  51.  
  52.         3. IconSprite
  53.         -------------
  54.         IconSprite's main function is merging sprite files with the wimp sprite
  55.         pool. Simply drag the file to the Palette Utility icon on the iconbar.
  56.         It has the advantage over the *command '*IconSprites' that it does not
  57.         attempt to add a mode suffix in high-res modes. This means that you can
  58.         load an application's mode 12 sprites no matter what mode you are in.
  59.  
  60.         If the Shift key is held down as a sprite file is dragged to the
  61.         Palette Utility icon, the command '*ToolSprites' is performed on it
  62.         instead. This allows you to try out different window border files
  63.         easily.
  64.  
  65.         In both the above cases, a 'clean' redraw of the desktop is performed
  66.         after the sprite file has been loaded. You can perform such a redraw at
  67.         any time by simply clicking ADJUST on the Palette Utility icon.
  68.  
  69.         If you have a Risc PC, all the above should now work using the Display
  70.         Manager icon instead of the Palette Utility. If you are using Andrew
  71.         Sellors's Outline Wimp desktop enhancement package on RISC OS 3.1x
  72.         (which is highly recommended!) then it will work with Desktop Control.
  73.         This does mean that you can't get at Desktop Control's adjust-click
  74.         dialogue, but since all the dialogues are available from the menu
  75.         anyway this shouldn't be too much of a problem. You can always turn
  76.         IconSprite off if you don't like it.
  77.  
  78.         IconSprite is on by default (see 'Configuration').
  79.  
  80.         4. FilerPin
  81.         -----------
  82.         FilerPin simply intercepts attempts to iconise directory displays, and
  83.         pins the relevant directories to the pinboard instead.
  84.  
  85.         Note that this filter does not become active until the Filer has
  86.         received at least one UserMessage or UserMessage_Recorded. This means
  87.         that it is possible that your first attempt will actually iconise the
  88.         window as normal. Subsequent attempts should work fine. Simply opening
  89.         a directory from an iconbar drive icon is enough to create such an
  90.         event, however, so this is pretty unlikely.
  91.  
  92.         FilerPin will work with any backdrop utility that supports Pinboard's
  93.         '*Pin' command. I don't know if anything other than Pinboard has this
  94.         though.
  95.  
  96.         FilerPin is on by default (see 'Configuration').
  97.  
  98.         5. DontClaim
  99.         ------------
  100.         Only likely to be of interest to programmers, this option when selected
  101.         prevents Pinboard from acknowledging Message_WindowClosed. This means
  102.         that the message is then able to be received by other tasks. (What it
  103.         actually does is to allow the message to be stopped, and then
  104.         re-broadcasts it).
  105.  
  106.         Note that this option also uses the filter called 'PinFilter' - so
  107.         'PinFilter' can still appear in the *Filters list even when the
  108.         PinFilter option is not set.
  109.  
  110.         DontClaim is on by default (see 'Configuration').
  111.  
  112.         6. PinFilter
  113.         ------------
  114.         PinFilter allows files to be dragged from the save dialogues of
  115.         applications to the pinboard. They are then saved into the directory
  116.         'PinFilter:Temp' which is located by default inside the !Filters
  117.         application directory. The file icon is pinned to the pinboard for easy
  118.         retrieval.
  119.  
  120.         Should you wish to save the temporary files elsewhere, simply comment
  121.         out the line that sets PinFilter$Path in the file !Filters.!Boot, and
  122.         set up PinFilter$Path to point where you want it. Note that the
  123.         directory is still required to be called 'Temp'.
  124.  
  125.         To clear out the temporary directory (since the pinboard provides no
  126.         facility for deleting files) just click on the item 'Info' in the
  127.         Pinboard menu. This will open a directory display of the temporary
  128.         directory.
  129.  
  130.         In addition, PinFilter has a 'delete-after' option (see 'Configuring
  131.         TaskFilters'). When selected, files are deleted from the temporary
  132.         directory after a configurable number of days. Note that expiry of
  133.         files is only checked when TaskFilters starts up.
  134.  
  135.         If you are using the SetCSD option in TaskFilters (!Filters), dragging
  136.         the switcher icon to the backdrop will set the currently selected
  137.         directory to PinFilter's temporary directory.
  138.  
  139.         PinFilter will only work with Pinboard, and not with any other backdrop
  140.         applications. This should not be a problem since any backdrop
  141.         application worth using will already provide this feature.
  142.  
  143.         PinFilter is on by default (see 'Configuration').
  144.  
  145.         7. Basket
  146.         ---------
  147.         After a brief disappearance (version 0.38) Basket is now back.
  148.  
  149.         Basket is a _very_ basic waste-basket type program. With this filter
  150.         installed you get a waste paper basket icon on the left hand side of
  151.         the iconbar. Dragging files to this icon will put them into a bin
  152.         directory (inside the !Filters directory - but you can change its
  153.         position from the Boot file) and delete them from their original
  154.         location. If you decide you have deleted the wrong file, just click on
  155.         the basket and you can get it back!
  156.  
  157.         Basket also uses a post-filter to intercept ordinary 'Delete'
  158.         operations from the Filer menu, and moves those files into the basket
  159.         as well.
  160.  
  161.         A small problem - how do you actually get rid of stuff from the basket,
  162.         now that the action of 'Delete' has changed?  Simple - click on 'Empty'
  163.         in Basket's iconbar menu to clear out the directory.
  164.  
  165.         In addition, Basket also has a 'delete-after' option similar to
  166.         PinFilter's. Normally the files are only checked when TaskFilters
  167.         starts up, but you can force Basket to check expiry at any time by
  168.         clicking on 'Expire' in Basket's iconbar menu. (This is greyed out if
  169.         'delete-after' is not configured for Basket).
  170.  
  171.         N.B.    Like Confirm, Basket only works if you have filer action
  172.                 windows running - so be careful when you're running out of
  173.                 memory!
  174.  
  175.         Basket is *off* by default (see 'Configuration').
  176.  
  177.         Note that users of Alexander Thoukydides's "Sensible Time" module,
  178.         Sensible, should not let it substitute the date format %yr%mn%dy,
  179.         because this screws up Basket totally. Alternatively, they could just
  180.         turn off Basket. The default configuration of Sensible leaves this
  181.         format alone, so you are probably okay.
  182.  
  183.         8. Iconise
  184.         ----------
  185.         Iconise allows you to iconise windows without using the keyboard. To
  186.         select your preferred option see 'Configuration'.
  187.  
  188.         The first option is a MS Windows style 'Iconise Gadget' - an extra tool
  189.         next to the close icon on the window border. Simply clicking on this
  190.         gadget will iconise the window. Note that by default this option will
  191.         load the sprite file 'Filters.Tools' as window borders. You can edit
  192.         this file, and the patch will still work provided:
  193.  
  194.                 (i)     the various 'cicon' sprites within the file all consist
  195.                         of close and iconise gadgets of equal width, with a
  196.                         single column of pixels between them (see the default
  197.                         file for examples),
  198.  
  199.                           cicon, cicon22, cicon 23:
  200.  
  201.                                     equal widths
  202.                                           |
  203.                                       ----------
  204.                                      |          |
  205.                                 |--------| |--------|
  206.  
  207.                                  --------- ---------
  208.                                 |  close  | iconise |
  209.                                 |  icon   | icon    |
  210.                                 |         |         |
  211.                                  --------- ---------
  212.  
  213.                                           |
  214.                                     single column
  215.  
  216.                 (ii)    that you resave your options file (see 'Configuring
  217.                         TaskFilters') after having saved the modified version
  218.                         of '!Filters.Tools' - this is necessary since
  219.                         TaskFilters needs to record the widths of the relevant
  220.                         window gadgets.
  221.  
  222.         If you wish to keep your window borders in a different place, change
  223.         the setting of the system variable Filters$Tools in the file
  224.         !Filters.!Boot.
  225.  
  226.         If you wish to perform the *ToolSprites command on the file yourself,
  227.         rather than having Iconise do it for you, simply deselect the option
  228.         'Module loads tools' (see 'Configuration').
  229.  
  230.         The second option iconises a window when you click and hold down 'menu'
  231.         over the window's close icon, then click select before releasing the
  232.         menu button - the action of 'menu' simply duplicates that of the shift
  233.         key for iconising.
  234.  
  235.         The third option iconises a window when you click 'adjust' on the
  236.         window's back icon. Note that you _can't_ use this to iconise windows
  237.         that don't have close icons - this is deliberate. Some tasks (for
  238.         example, Miles Sabin's wonderful Bubble Help) don't like having these
  239.         windows iconised.
  240.  
  241.         The final option iconises a window when you click 'select' over the
  242.         window's close icon, and hold down the button for a configurable length
  243.         of time, DoubleTake style. The time may be between 10 and 255
  244.         centiseconds - I recommend a value of about 25 cs.
  245.  
  246.         In all four cases, it is still possible to iconise the window in the
  247.         usual way ('shift-select' on the close icon).
  248.  
  249.         Iconise should work with any iconised window manager or backdrop
  250.         application that supports the iconise protocol (!Larger, !Iconiser
  251.         etc).
  252.  
  253.         Iconise is on by default, with the iconise gadget as the selected
  254.         method of iconising, and widths set up for the supplied tool file. (see
  255.         'Configuration').
  256.  
  257.  
  258. Installation
  259. ------------
  260.         To install the patches, simply double click on the !Filters icon in the
  261.         directory display. Alternatively run the application from some sort of
  262.         desktop boot sequence - on a Risc PC, for example, you would copy it
  263.         into !Boot's 'Tasks' directory.
  264.  
  265.  
  266. Aaagh! Get rid of it!
  267. ----------------------
  268.         To remove TaskFilters temporarily, you can quit the module task from
  269.         the Task display menu. The filters will then reinitialise the next time
  270.         the desktop restarts. To remove TaskFilters more permanently, use the
  271.         *command '*RMKill TaskFilters'.
  272.  
  273.  
  274. Configuration
  275. -------------
  276.         To configure TaskFilters, click with SELECT while holding down either
  277.         Alt key on the switcher icon. This will open a configuration window
  278.         that allows you to change the patches installed, and set options for
  279.         some of them. Clicking on 'Save' writes your choices to the file
  280.         <Filters$Options>.
  281.  
  282.         If this file does not exist, sensible default options are assumed, and
  283.         the file is created the first time you choose options that differ from
  284.         these.
  285.  
  286.  
  287. Licence
  288. -------
  289.         TaskFilters is freeware.  By this I mean that it may be freely
  290.         distributed as long as the application is complete (including this help
  291.         file) and nothing is modified.  It would be a good idea to delete your
  292.         'Options' file and to check that the Basket and PinFilter temporary
  293.         directories are empty before distribution.
  294.  
  295.         TaskFilters is supplied "as is", and without guarantee.  Please note
  296.         that the author accepts no responsibility for anything nasty that
  297.         happens as a result of the existence of TaskFilters or its associated
  298.         files - you use them entirely at your own risk.
  299.  
  300.         Anyone wanting to distribute TaskFilters on a large scale (CD ROMs,
  301.         cover discs etc.) should contact me first, to make sure they have the
  302.         latest version.
  303.  
  304.  
  305. Bugs
  306. ----
  307.         Should you find any, it would be helpful if you could let me know what
  308.         they are. Unfortunately I am currently without an e-mail address, but
  309.         my postal address is:
  310.  
  311.                 23 Conifer Close
  312.                 Church Crookham
  313.                 Fleet
  314.                 Hants
  315.                 GU13 0LR
  316.  
  317.                 tel. (01252) 617646
  318.  
  319.         Comments and suggestions are also welcome.
  320.  
  321.  
  322. Credits
  323. -------
  324.         Various parts of TaskFilters are based on ideas from:
  325.  
  326.                 Keith Broadley, Keven Cook, Aidan Corey, Adam Hamilton, Grant
  327.                 Ingram, S.J. McDonald, Jonathan Mist, Robin Moffat and Gunnar
  328.                 Zötl.
  329.  
  330.         In particular Keven Cook (the other half of KCE Software) worked out
  331.         how to implement the iconise gadget, and co-wrote the code for it. The
  332.         tool sprites provided are based on Acorn's NewLook set.
  333.  
  334.         The utility 'PinDir' (in a directory accompanying this application)
  335.         is written by Gert-Jan de Vos - see PinDir's own !Help file for
  336.         more information.
  337.  
  338.         The configuration task is written using DeskLib version 2.16. All other
  339.         code is my own.
  340.  
  341.         Thanks for bug reports go to:
  342.  
  343.                 Thomas Boroske, Keven Cook, Aidan Corey, Tim Gladding,
  344.                 Ian Roberts, Reuben Thomas, and Tromp Willemse. Probably some
  345.                 others too - sorry if I have left you out!
  346.  
  347.  
  348. -------------------------------------------------------------------------------
  349.                                      "It's over... GO AWAY!" -- Slappy Squirrel
  350.